docs: convert remaining code examples from CommonJS to ESM - #3051
Open
Agi-Asi wants to merge 1 commit into
Open
Conversation
The quickstart guides and README already use ESM imports; the concept, deployment, and tutorial pages listed in slackapi#2923 still used require() and module.exports. Convert exactly the in-scope files from that issue's checklist (11 English + 8 Japanese): - const { X } = require('pkg') -> import { X } from 'pkg' - const X = require('pkg') -> import X from 'pkg' - module.exports.handler = ... -> export const handler = ... (AWS Lambda deployment docs, both languages) The legacy steps-from-apps pages stay untouched, as called out under 'Out of scope' in the issue. npm run lint (biome covers docs/) passes. Fixes slackapi#2923
|
Thanks for the contribution! Before we can merge this, we need @Agi-Asi to sign the Salesforce Inc. Contributor License Agreement. |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #2923. Converts the remaining CommonJS code examples to ESM, covering exactly the in-scope checklist from that issue — 11 English pages (concepts: authenticating-oauth, custom-routes, deferring-initialization, error-handling, logging, message-listening, receiver, socket-mode, token-rotation; deployments: aws-lambda; tutorials: code-assistant) and 8 Japanese counterparts.
Conversions applied:
const { X } = require('pkg')→import { X } from 'pkg'const X = require('pkg')→import X from 'pkg'module.exports.handler = async (…)→export const handler = async (…)(AWS Lambda deployment docs, both languages — the case specifically called out in the issue notes)The deprecated
legacy/steps-from-apps.mdpages are untouched, per the issue's "Out of scope" section. No prose changes — code fences only.Verified: zero
require(/module.exportsremaining across the in-scope files, andnpm run lint(biome checksdocs/) passes.Requirements